Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: authentication primitives: improved security and performance infos (master) #6667

Merged
merged 5 commits into from
May 14, 2022

Conversation

py0xc3
Copy link
Contributor

@py0xc3 py0xc3 commented May 5, 2022

See #6666
1st draft of adjusted security.rst (no changes to init.rst.inc yet).
Shift focus and help to choose the best authentication primitive.

See borgbackup#6666 
1st draft of adjusted security.rst
@ThomasWaldmann
Copy link
Member

@enkore can you please review?

Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your PR. I reviewed the more practical part.

docs/internals/security.rst Outdated Show resolved Hide resolved
docs/internals/security.rst Outdated Show resolved Hide resolved
@py0xc3
Copy link
Contributor Author

py0xc3 commented May 6, 2022

Interesting phenomenon. Ice Lake has indeed already the extensions, but I cannot find information on Intel.com that its successor Tiger Lake has it as well. But I think we can assume it contains them, too. Apple's processors are also worth to be named on themselves given the widespread use. Thanks for the notes.

However, I think your approach of benchmark makes more sense on the long term: the user shall make a benchmark and use what is fastest. lscpu would be an alternative to identify the extensions, although this works not on all OS.

But maybe it makes sense to enable a benchmark that does not need the creation of a repo in advance, and then replace my whole adjustment about the architectures and their extensions by one or two sentences about how and why to make the benchmark? So, facilitating an initial benchmark as first step before creating the first borg repo on a system.

I can write an adjustment in the next few days.

@enkore
Copy link
Contributor

enkore commented May 6, 2022

There's "borg benchmark cpu" specifically for doing those tests. I don't know if it does, but a nice thing there would be to just plainly tell you which mode is quickest on your system, and associated caveats if any.

Christopher Klooz added 3 commits May 13, 2022 22:36
Correction of processors with SHA extensions
Add Apple and ARM
@py0xc3
Copy link
Contributor Author

py0xc3 commented May 13, 2022

There's "borg benchmark cpu" specifically for doing those tests. I don't know if it does, but a nice thing there would be to just plainly tell you which mode is quickest on your system, and associated caveats if any.

My point was that "borg benchmark *" seems to need a repo that already exists before it can run. So, a user would need to create a repo, then do the benchmark, and then potentially delete the repo again to create a new one with a different primitive. Maybe this can be simplified in future versions? It would be definitely the better approach to just let the user know how to do the benchmark and then choose the primitive that is fastest.

"borg benchmark cpu" leads to the error "borg benchmark: error: argument : invalid choice: 'cpu' (choose from 'crud')" on my system, but I expect this is because I have currently no borg repo.

@ThomasWaldmann
Copy link
Member

borg benchmark cpu is only in master branch and does not require a repo. it does pure algorithmic tests without I/O.

@py0xc3
Copy link
Contributor Author

py0xc3 commented May 14, 2022

borg benchmark cpu is only in master branch and does not require a repo. it does pure algorithmic tests without I/O.

I was not aware of this :) In this case, it makes sense to already prepare the docs in master branch for that. I will delete all the architecture stuff and simply refer to how to use and interpret "borg benchmark cpu". I will use your example of #6666

@ThomasWaldmann
Copy link
Member

You could keep the architectural stuff for a 1.2-maint PR.

Yes, for master, you can just refer to borg benchmark cpu.

Introducing borg benchmark cpu
@py0xc3
Copy link
Contributor Author

py0xc3 commented May 14, 2022

security.rst is updated & "borg benchmark cpu" is introduced. You may verify my syntax with commands (such as "borg benchmark cpu") because my experience with readthedocs is limited.

py0xc3 pushed a commit to py0xc3/borg that referenced this pull request May 14, 2022
Update of 1.2-maint as suggested in borgbackup#6667
py0xc3 pushed a commit to py0xc3/borg that referenced this pull request May 14, 2022
Changes as suggested in borgbackup#6667
@ThomasWaldmann ThomasWaldmann changed the title Update security.rst docs: authentication primitives: improved security and performance infos (master) May 14, 2022
Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ThomasWaldmann ThomasWaldmann merged commit 594d83a into borgbackup:master May 14, 2022
@ThomasWaldmann
Copy link
Member

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants